Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace relrefs with docrefs in Agent tutorials #5578

Merged
merged 7 commits into from
Oct 24, 2023

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Oct 23, 2023

PR Description

The relref shortcode is being deprecated in favour of the docs/reference shortcode. The new shortcode allows us to have more control over the references and links and makes sure that topics mounted into more than one project can have working links within that project.

This PR continues the process of migrating the Flow documentation to use the docs/reference shortcodes as preparation for mounting Flow topics into the Cloud docs

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added type/docs Docs Squad label across all Grafana Labs repos backport release-v0.37 labels Oct 23, 2023
@clayton-cornell clayton-cornell requested a review from a team October 23, 2023 22:27
@clayton-cornell clayton-cornell marked this pull request as ready for review October 23, 2023 22:27
Copy link
Contributor

@erikbaranowski erikbaranowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, a couple links to check in on

docs/sources/flow/tutorials/filtering-metrics.md Outdated Show resolved Hide resolved
@clayton-cornell clayton-cornell enabled auto-merge (squash) October 24, 2023 20:09
@clayton-cornell clayton-cornell merged commit 97f1013 into main Oct 24, 2023
7 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-relrefs-tutorials branch October 24, 2023 20:13
grafanabot pushed a commit that referenced this pull request Oct 24, 2023
* Update relrefs collect prom components

* Update relrefs in filtering metrics

* Update relrefs in chaining topic

* Update links to assets

(cherry picked from commit 97f1013)
clayton-cornell added a commit that referenced this pull request Oct 24, 2023
* Update relrefs collect prom components

* Update relrefs in filtering metrics

* Update relrefs in chaining topic

* Update links to assets

(cherry picked from commit 97f1013)

Co-authored-by: Clayton Cornell <[email protected]>
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.37 frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants